►
From YouTube: User Profile Bulk update API demonstration
Description
In this video we'll demonstrate the new Bulk UPA Custom Profile Properties Update API, which enables you to import easily and efficiently additional attributes to SharePoint Online user profiles. You can use this API to update user profile properties, which are not imported from the Azure Active Directory.
Source code for the demonstrated code sample is available from PnP Code Gallery (http://dev.office.com/patterns-and-practices-detail/7202).
Video covers following topics:
- Where to find more source code for the demonstrated sample
- What are the requirements for user profile properties in SharePoint Online to be able to import information
- How to start user profile bulk import job
- How to check the status of user profile bulk import job
- How possible exceptions are handled for the execution
A
Hello,
my
name
is
Josiah
Vernon
and
in
this
particular
video
we'll
have
look
on
the
new
book.
You
use
the
profile
application,
custom
profile
properties,
update
ABI,
it's
a
long
term
for
a
functionality
which
will
actually
help
you
to
my
create
a
custom
attributes
or
user
profile
values
from
any
line
of
business
system.
Like
a
chart
system
from
on-premises
to
SharePoint
Online
do
easiest
way
you
can
access
the
source
code,
which
we
will
have
a
look
on
here
is
by
going
to
the
left
office,
com
click,
resources
patterns
and
practices
and
independence
and
practices
code.
A
Examples
search
you
can
just
use
the
term
like
User,
Profile
and
you'll
see
this
user
profile.
That's
update,
API
available
within
the
patterns
right
today's
samples,
so
we're
going
to
click
that
one
and
we'll
see
a
short
summary
on
the
on
the
functionality
and
the
sample,
and
that's
also
in
pointing
to
the
github
location,
where
the
actual
source
code
is
existing,
so
the
user
profile
button
up
data
API
or
whatever
we
actually
want
to
call.
A
This
will
help
you
to
migrate
information
from
the
lob
systems
or
Active
Directory
from
on-premises
or
from
assure
the
user
profiles
in
the
in
the
sharepoint
online,
and
this
is
needed
because
you
cannot
modify
which
attributes
are
getting
synchronized
from
the
usher
active
directory
to
the
sharepoint
online
user
profile
store.
So
let's
have
a
look
on
the
on
the
functionality
first
from
a
code
perspective
and
then
we'll
have
a
look
on
on
the
individual
functionalities.
So
here
we
go
here's
the
sample.
So
this
is
solution.
A
A
The
source
file
is
in
a
chase
informant,
and
this
is
a
relatively
simple
source
file,
but
it
demonstrates
the
API
behavior,
so
we
do
have
a
individual
values
or
individual
properties
for
in
virtual
persons,
in
this
particular
sample
case,
were
using
the
email
as
the
identifier
to
find
the
target
user
profile
in
the
user
profile
story
within
a
SharePoint
Online
and
which
will
then
update
this
additional
attribute.
I
have
here
intentionally
a
one
unknown
address,
so
you
will
see
also
the
exception
handling,
so
how
things
are
actually
executed.
A
If
there's
any
persons
who've
left
the
company
or
for
a
reason
or
another,
there's
a
mistake
within
the
email
which
is
within
the
format
or
within
the
JSON
file.
But
the
target
is
essentially
to
get
the
profile
property
or
these
properties
one
and
to
update
it
to
the
User
Profile
properties
within
SharePoint
Online
site
before
we
actually
run
the
code
and
there
is
a
one
requirement
for
the
target
properties.
So
let's
actually
jump
back
on
the
on
the
browser
and
I'm
gonna
actually
show
you
that
one
from
the
tenant
administrative
side.
A
So
if
you
go
to
the
SharePoint
admin
center,
if
you
go
to
the
user
profiles
and
then
have
a
look
on
the
user
profile
properties,
we
can
only
target
our
update
user
profile
properties
which
are
not
editable
by
the
end
users.
Technically,
you
can
update
also
attributes
which
are
getting
replicated
automatically
from
the
usher,
Active
Directory,
but
that
doesn't
really
make
any
sense.
So
as
an
example
in
this
demo,
we
can
update
the
city
and
office
attributes
which
are
available
within
the
user
profile
store.
A
So,
for
example,
for
the
city
attribute,
which
could
indicate
on
which
location
the
office
of
the
particular
person
is
located.
We
need
to
have
that
property,
not
editable
by
the
user.
So
if
I
click
the
edit
button
or
edit
for
the
property,
we
can
then
go
and
see
the
property
settings.
So
this
is
a
custom
property
which
we
don't
have
by
default
in
a
shipment
online
I
created
that
pretty
recently
in
my
tenant
it
has
a
name
of
City
display,
name
city
length
is
255
characters
and
then
the
key
point
is
the
following
setting
here.
A
So
this
is
not
allowed
users
to
edit,
because
otherwise
you
might
end
up
in
a
situation
where
you
are
actually
audience.
Users
are
modifying
those
values
and
then
your
batch
operation,
which
could,
for
example,
run
daily
to
synchronize
some
values
from
your
HR
system
within
overwrite
and
those
settings
within
the
SharePoint
Online
good
to
be
able
to
use
the
API.
A
We
need
to
get
that
source
file
the
JSON
file
located
somewhere
within
that
particular
tenant,
and
in
this
particular
case,
what
I've
done
is
that
I've
uploaded
that
sample.txt
file,
which
is
part
of
the
sample
available
from
the
patterns
and
practices
to
a
document
library.
This
is
out
at
the
Box
team
site
document
library,
and
we
have
that
sample
file
here
available.
So
we
can
use
that
as
the
source
file
or
pinpoint
the
API
to
actually
read
that
file.
Whenever
the
time
a
job
in
server-side
will
start
processing
the
files.
A
We
do
have
here
a
few
folders
which
I'm
going
to
explain
slightly
later,
but
these
aren't
actually
look
entries
from
the
previous
executions.
So
if
there
has
been,
for
example,
an
exceptions
or
errors
when
that
file
has
been
processed,
those
exceptions
and
errors
will
be
shown
within
this
lock.
Files
so
really
want
to
kind
of
a
thing
true,
where
you
want
to
store
this
file,
because
those
folders
are
gonna,
be
generated,
they're
based
on
all
of
the
executions,
and
you
also
want
to
have
a
automated
way
or
think
through.
A
How
do
you
archive
or
delete
these
log
files
as
well
by
default?
The
API
doesn't
do
that,
which
is
something
to
be
aware
and
that's
absolutely
a
great
opportunity
for
community
development,
maybe
to
have
an
usher
web-based
web
job
based
implementation
with
system
reading
a
file
if
it
has
modifications
and
also
deletes
the
old
log
files.
But
let's
have
a
look
on
the
under
actual
see
some
new
season,
API,
so
I'm
going
to
jump
back
on
the
visual
studio
and
I'm
going
to
open
up
my
programs
ES
file,
which
is
actually
having
the
business
logic.
A
So
this
is
relatively
simple
program.
It's
asking
me
which
tenant
which
username,
which
password
and
the
file
located
in
the
our
tenant
and
after
that
it
starts
processing
the
file.
So
let's
actually
run
through
that
together.
So
you
are
able
to
see
how
the
sample
actually
works.
One
thing
what
I
wanted
to
pin
point
here
is
that
if
we
have
a
look
quickly,
look
on
the
on
the
nougat
packages,
so
we
do
have
a
reference
to
Microsoft
SharePoint
Online
season
and
the
minimum
version
which
you
need
to
use
is
the
sixteen
point.
A
A
Let's
go
back
on
the
programs,
yes,
I'm,
going
to
do
an
f5
start
executing
the
file
and
I'm
going
to
show
you
what
actually
happens
or
how
the
sample
actually
works.
So
there
we
go
our
console
application
starts.
It
is
requesting
first,
the
admin
URL
of
the
tenant,
so
let's
actually
fill
on
that
one.
A
So
there
we
go.
That's
my
admin
URL
to
my
tenant.
It
is
then
asking
what's
my
name
or
the
account
which
were
going
to
use
to
connect
to
that
admin.
Url,
let's
also
add
the
password
and
then
it's
going
to
ask
me:
okay,
excellent
I'm,
ready
to
go
where's
the
file
which
I
need
to
process.
So
you
need
to
ensure
that
the
file
is
located
somewhere
in
the
SharePoint
tenant,
which
you
want
to
target
those
changes
to.
A
So
let's
actually
write
that
message:
a
SharePoint
that
comes
last
sites
last
themes,
last
Docs
sample
dot,
txt,
and
that
was
the
location
of
the
sample
file,
which
we
will
process
and
also
the
center
location
of
the
of
the
sample
file,
will
define
where
the
looks
will
be
then
down
at
it
as
well.
So
there
will
be
added
on
that
same
document
library,
if
there's
any
exceptions.
A
So
let's
start
executing
we're
hitting
a
first
parade
point,
so
we're
connecting
the
well
first
of
all
we're
we're
connecting
the
tenant
site,
and
this
is
just
to
check
the
connectivity
and
permissions
and
so
we're
able
to
actually
get
that
the
information
outside
of
the
tenant
there
we
go.
We
have
a
title
tonight,
administration
site,
which
is
correct.
Then
we
need.
Then
we
actually
concentrate
on
the
real
code,
which
is
having
the
new
API.
So
we
take
an
instance
on
office
365
tenant.
A
We
load
that
one
which
not
is
not
necessarily
even
actually
needed,
but
the
key
API
is
and
methods
are
within
that
object.
The
next
thing
to
do
is
to
list
to
tell
for
the
code
or
the
the
user
profile
patch
import
process,
what
kind
of
identity
we
want
to
match,
or
the
the
user
profile
within
the
within
the
SharePoint
site
or
within
the
SharePoint,
a
user
profile
store
and
let's
quickly,
have
a
look
on
the
JSON
format.
A
So
in
this
case
we're
gonna
use,
email
and
essentially,
what
we
are
doing
here
is
that
we're
saying
that
the
ID
name
attribute
is
an
email.
It
could
be
cloud
ID.
It
could
be
something
else
as
well.
So
the
few
different
options
to
use
here
as
the
as
the
identifier
for
the
account
which
we
want
to
target
the
matching
and
then
we
are
saying
that
the
property
within
the
dxd
file
is
ID
name.
A
It
could
be
again
anything
that,
but
that's
the
lookup
key
photo
identity,
and
then
we
are
defining
what
kind
of
values
we
have
within
the
chase
on
file,
and
in
this
case
we
have
a
property,
one
and
property
two
and
then
we're
saying
to
which
user
profiles,
service,
property
properties
will
match
those
values.
So,
let's
again
jump
back
onto
sample.txt
and
have
a
look
on
this
one.
We
have
a
property
one,
our
property,
one
and
property
two,
and
that
seems
to
be
an
office,
and
that
seems
to
be
something
else.
A
What
that,
since
the
bed
city
and
that
seems
to
be
office,
so
the
property
one
will
be
then
mapped
to
city
and
the
property
two
will
be
mapped
to
so
the
the
processing
will
then
know
which
of
the
width
of
the
entries
will
be
met,
mapped
to
which
user
profile
properties
and
then
we
are
calling
the
queue,
import
profile,
properties
over
PI,
passing
to
user
profile,
I
didn't
identity
type,
the
what's,
the
lookup
key
wants
to
property
mapping
and
the
URL
to
the
specific
file.
At
this
point,
the
engine
will
do
some
level
of
checking.
A
It's
all,
for
example,
checking
that
the
properties
are
fine,
the
properties
do
exist
and
they
have
the
right
property
values
within
the
user
profile
store
and
that's
it.
The
item
has
been
queued
for
execution
we
do
have
and
whenever
we
do,
that,
we
will
get
actually
a
unique
identifier
of
this
user
profile,
property
bulk
import
property
job,
and
we
can
use
that
for
checking
the
status
of
that
particular
that
particular
job.
So
we
do
have
to
do
two
different
ways
of
doing
that
in
a
tenant
object.
A
We
do
have
a
kit
import
property
job
with
the
work
item,
ID
and
so
we're
giving
that
idea,
which
we
just
get
got
and
load
that
one
from
the
tenant
and
in
this
case
we're
then
getting
an
input
of
that
particular
status
of
that
particular
execution,
and
we
can
see
that
it's
test
ID
the
request
status
is
submitted.
Our
status
is
no
error,
so
nothing
has
been
yet
executed.
A
So
there's
no
errors
on
the
execution
or
we
could
actually
query
all
of
the
user
profile,
import
jobs
and
that's
what
we
get
import
profile,
property
jobs
and
that's
going
to
then
return
numerius
jobs
which
have
been
executing
within
my
tenant.
So
we
can
actually
get
all
of
those
out
in
the
console
application.
So
there's
like
five
or
four
four
of
those,
and
that's
all
that's
it
for
my
API
perspective.
A
So
we
can
see
actually
that
in
my
case
that
we
have
for
individual
executions
within
my
tenant,
and
one
of
them
is
the
sub
in
the
submitted
status
and
that's
the
same
one,
which
we
specifically
queried
and
using
that
specific,
give
me
a
one
chirp
status.
There's
previous
executions
have
returned
a
an
exception
and
with
the
error
status
of
import
complete
with
error,
so
there
has
been
an
except
execution
or
an
exception
when
the
files
have
been
important
and
let's
actually
have
a
look
on
that
one
quickly.
A
So
if
we
continue
or
I'll
just
quickly
do
an
enter
there,
so
we
can
shut
down
to
the
execution
and
let's
move
back
on
the
on
the
browser.
So
whenever
there
is
an
exception
on
importing
any
of
those
JSON
files.
If,
for
example,
the
JSON
file
format
is
wrong
or
if
there's
an
identity
which
we
cannot
match
with
in
this
particular
tenant,
we
will
actually
get
a
folder
automatically
created
in
this
in
the
same
folder,
where
we
had
that
source
file.
A
So
that
folder
is
is
for
a
one
specific
execution,
and
if
we
go
to
the
folder
itself,
we
are
able
to
see
additional,
lock
information.
So
if
I
open
up
this
one
and
let's
open
up
that
one
in
a
notepad,
we're
able
to
then
say
the
actual
details
around
the
exception,
which
just
happened-
and
this
was
pretty
much
as
expected,
because
in
the
sample
file
we
have
a
email
which
I
know
that
doesn't
exist
within
my
tenant.
A
So
you
can
actually
follow
up
on
on,
if
you
have,
let's
say
mistakes
within
a
source
file
or
identities.
So
you
get
all
of
that
information
within
these
locks
and
that's
pretty
much
it
from
the
API
perspective.
Relatively
simple
set
of
API
is
how
to
queue
up
the
ID,
how
to
clear
up
the
jobs,
how
to
hide
it
and
map
the
things.
The
one
thing
maybe
to
show,
as
well
as
part
of
the
sample.
A
We
absolutely
have
a
sample
how
to
do
exactly
the
same
thing
using
just
native
PowerShell,
which
is
actually
taking
advantage
of
the
see
ISM
as
same
place
as
well.
So
you
don't
have
to
write
any
code.
You
can
modify
the
script,
the
mature
environment
and
you
can
see
pretty
much
the
same
structure
within
the
source
code.
So
we're
saying
that
identity
is
email.
We're
saying
that
the
lookup
key
is
specific,
which
in
this
game
seems
to
be
actually
not
matching.